11.1 Custom client configuration files

Custom client configuration files each contain the details for a single client, which is identified by its ClientID. If the ClientID already exists in the appsettings.Production.json or appsettings.json file, the details from the custom client configuration file completely replace the existing settings for that client; if the ClientID does not exist, the client is added to the configuration for the web service.

Note: You can continue to use the appsettings.Production.json file for your client configuration if you want, but you are recommended to move any clients you have created into their own custom client configuration files.

To create a custom client configuration file:

  1. On the MyID web server, navigate to the CustomClients folder.

    By default, this is:

    C:\Program Files\Intercede\MyID\web.oauth2\CustomClients\

    If this folder does not already exist, create it.

  2. In a text editor, create a .json file to contain your client configuration.

    You can use any filename with a .json extension; you are recommended to use the name you have provided for the client as the filename.

    You can create a custom .json file for each client that you want to add. You can include only one client in each file, but you can have multiple files if you need multiple clients. These clients are added to the Clients array from the appsettings.json file. You must use a unique ClientID; if you use the same ClientID in a custom file as an already existing client in the appsettings file, the information from the custom file completely replaces the information in the appsettings.json or appsettings.Production.json override file.

    The order of precedence is:

    • any .json file in the CustomClients folder.

    • appsettings.Production.json

    • appsettings.json

    Note: The appsettings.Production.json file overrides the appsettings.json file not by using the client ID, but by the index of the entry in the Clients array. For this reason, you are recommended not to use the appsettings.Production.json file to provide the details of custom clients, but to use separate files in the CustomClients folder instead.